| Package | hl7.fhir.au.pd |
| Type | StructureDefinition |
| Id | Id |
| FHIR Version | R4 |
| Source | http://hl7.org.au/fhir/pd/http://hl7.org.au/fhir/pd/pd2/StructureDefinition-au-pd-sm-endpoint.html |
| Url | http://hl7.org.au/fhir/pd/StructureDefinition/au-pd-sm-endpoint |
| Version | 2.0.1 |
| Status | draft |
| Date | 2019-05-14T00:00:00+10:00 |
| Name | AUPDSecureMessagingEndpoint |
| Title | AU PD Secure Messaging Endpoint |
| Experimental | False |
| Realm | au |
| Authority | hl7 |
| Description | Endpoint for secure message delivery |
| Type | Endpoint |
| Kind | resource |
| StructureDefinition | |
au-pd-healthcareservice  | AU PD Healthcare Service |
| au-pd-practitionerrole | AU PD Practitioner Role |
| StructureDefinition | |
| http://hl7.org.au/fhir/StructureDefinition/au-receivingapplication | HL7 V2 Receiving Application |
| http://hl7.org.au/fhir/StructureDefinition/au-receivingfacility | HL7 V2 Receiving Facility |
| http://hl7.org.au/fhir/StructureDefinition/encryption-certificate-pem-x509 | Encryption Certificate PEM X509 |
| http://hl7.org.au/fhir/pd/ValueSet/endpoint-payload-type | Australian Endpoint Payload Types |
| http://hl7.org.au/fhir/pd/ValueSet/service-interfaces | Australian Service Interfaces |
Note: links and images are rebased to the (stated) source
AU PD SM Endpoint
FHIR{
"resourceType" : "StructureDefinition",
"id" : "au-pd-sm-endpoint",
"meta" : {
"lastUpdated" : "2018-03-05T01:13:27.089+11:00"
},
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n <p>AU PD SM Endpoint</p>\n </div>"
},
"url" : "http://hl7.org.au/fhir/pd/StructureDefinition/au-pd-sm-endpoint",
"version" : "2.0.1",
"name" : "AUPDSecureMessagingEndpoint",
"title" : "AU PD Secure Messaging Endpoint",
"status" : "draft",
"date" : "2019-05-14T00:00:00+10:00",
"description" : "Endpoint for secure message delivery",
"fhirVersion" : "4.0.0",
"mapping" : [
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
}
],
"kind" : "resource",
"abstract" : false,
"type" : "Endpoint",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/Endpoint",
"derivation" : "constraint",
"snapshot" : {
"element" : [
{
"id" : "Endpoint",
"path" : "Endpoint",
"short" : "Australian Secure Message Directory Endpoint Record",
"definition" : "Enpoint defined for use in secure message addressing.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Endpoint",
"min" : 0,
"max" : "*"
},
"constraint" : [
{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $contained in f:contained return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "DomainResource"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}
],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.div.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "DomainResource"
}
],
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Endpoint.id",
"path" : "Endpoint.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "id"
}
],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Endpoint.meta",
"path" : "Endpoint.meta",
"short" : "Metadata on Endpoint",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Meta"
}
],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Endpoint.meta.id",
"path" : "Endpoint.meta.id",
"representation" : [
"xmlAttr"
],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Endpoint.meta.extension",
"path" : "Endpoint.meta.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Endpoint.meta.versionId",
"path" : "Endpoint.meta.versionId",
"short" : "Version specific identifier",
"definition" : "The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.",
"comment" : "The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Meta.versionId",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "id"
}
],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Endpoint.meta.lastUpdated",
"path" : "Endpoint.meta.lastUpdated",
"short" : "When the resource version last changed",
"definition" : "When the resource last changed - e.g. when the version changed.",
"comment" : "This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a [read](http://hl7.org/fhir/R4/http.html#read) interaction.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Meta.lastUpdated",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "instant"
}
],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Endpoint.meta.source",
"path" : "Endpoint.meta.source",
"short" : "Identifies where the resource comes from",
"definition" : "A uri that identifies the source system of the resource. This provides a minimal amount of [Provenance](http://hl7.org/fhir/R4/provenance.html#) information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.",
"comment" : "In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. \n\nThis element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Meta.source",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "uri"
}
],
"mustSupport" : true,
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Endpoint.meta.profile",
"path" : "Endpoint.meta.profile",
"short" : "Profiles this resource claims to conform to",
"definition" : "A list of profiles (references to [StructureDefinition](http://hl7.org/fhir/R4/structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](http://hl7.org/fhir/R4/structuredefinition-definitions.html#StructureDefinition.url).",
"comment" : "It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Meta.profile",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "canonical",
"targetProfile" : [
"http://hl7.org/fhir/StructureDefinition/StructureDefinition"
]
}
],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Endpoint.meta.security",
"path" : "Endpoint.meta.security",
"short" : "Security Labels applied to this resource",
"definition" : "Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.",
"comment" : "The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Meta.security",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Coding"
}
],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SecurityLabels"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}
],
"strength" : "extensible",
"description" : "Security Labels from the Healthcare Privacy and Security Classification System.",
"valueSet" : "http://hl7.org/fhir/ValueSet/security-labels"
}
},
{
"id" : "Endpoint.meta.tag",
"path" : "Endpoint.meta.tag",
"short" : "Tags applied to this resource",
"definition" : "Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.",
"comment" : "The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Meta.tag",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Coding"
}
],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Tags"
}
],
"strength" : "example",
"description" : "Codes that represent various types of tags, commonly workflow-related; e.g. \"Needs review by Dr. Jones\".",
"valueSet" : "http://hl7.org/fhir/ValueSet/common-tags"
}
},
{
"id" : "Endpoint.implicitRules",
"path" : "Endpoint.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "uri"
}
],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "Endpoint.language",
"path" : "Endpoint.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}
],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "Endpoint.text",
"path" : "Endpoint.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : [
"narrative",
"html",
"xhtml",
"display"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Narrative"
}
],
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "Act.text?"
}
]
},
{
"id" : "Endpoint.contained",
"path" : "Endpoint.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : [
"inline resources",
"anonymous resources",
"contained resources"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Resource"
}
],
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Endpoint.extension",
"path" : "Endpoint.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"rules" : "open"
},
"short" : "Extension",
"definition" : "An Extension",
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Endpoint.extension:receivingFacility",
"path" : "Endpoint.extension",
"sliceName" : "receivingFacility",
"short" : "HL7 V2 receiving facility",
"definition" : "Values for routing HLV2 message payloads associated with an endpoint, suitable for MSH-6",
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension",
"profile" : [
"http://hl7.org.au/fhir/StructureDefinition/au-receivingfacility"
]
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source" : "Extension"
}
],
"isModifier" : false
},
{
"id" : "Endpoint.extension:receivingApplication",
"path" : "Endpoint.extension",
"sliceName" : "receivingApplication",
"short" : "HL7 V2 receiving application",
"definition" : "Values for routing HLV2 message payloads associated with an endpoint. Suitable for MSH-5.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension",
"profile" : [
"http://hl7.org.au/fhir/StructureDefinition/au-receivingapplication"
]
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source" : "Extension"
}
],
"isModifier" : false
},
{
"id" : "Endpoint.extension:dataEnciphermentCertificate",
"path" : "Endpoint.extension",
"sliceName" : "dataEnciphermentCertificate",
"short" : "PEM X509 Certificate",
"definition" : "Mechanism hold the value of an X509 certificate as a string (base64 encoded PEM certificate)",
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension",
"profile" : [
"http://hl7.org.au/fhir/StructureDefinition/encryption-certificate-pem-x509"
]
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source" : "Extension"
}
],
"isModifier" : false
},
{
"id" : "Endpoint.modifierExtension",
"path" : "Endpoint.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Endpoint.identifier",
"path" : "Endpoint.identifier",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "system"
}
],
"rules" : "open"
},
"short" : "Identifies this endpoint across multiple systems",
"definition" : "Identifier for the organization that is used to identify the endpoint across multiple disparate systems.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Endpoint.identifier",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Identifier"
}
],
"isModifier" : false,
"isSummary" : true,
"mapping" : [
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Endpoint.identifier:smdtarget",
"path" : "Endpoint.identifier",
"sliceName" : "smdtarget",
"short" : "Secure Messaging Target Identifier",
"definition" : "Secure messaging interface target identity included in addressing metadata. Thiis is the complete URL identifier that can be directly used in secure messaging. This identifier should be matched when selecting the encrypting certificate data used for payload encryption also referenced from this endpoint.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Endpoint.identifier",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Identifier"
}
],
"mustSupport" : true,
"isModifier" : false,
"isSummary" : true,
"mapping" : [
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Endpoint.identifier:smdtarget.id",
"path" : "Endpoint.identifier.id",
"representation" : [
"xmlAttr"
],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Endpoint.identifier:smdtarget.extension",
"path" : "Endpoint.identifier.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Endpoint.identifier:smdtarget.use",
"path" : "Endpoint.identifier.use",
"short" : "usual | official | temp | secondary | old (If known)",
"definition" : "The purpose of this identifier.",
"comment" : "Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.",
"requirements" : "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Identifier.use",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"isModifier" : true,
"isModifierReason" : "This is labeled as \"Is Modifier\" because applications should not mistake a temporary id for a permanent one.",
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "IdentifierUse"
}
],
"strength" : "required",
"description" : "Identifies the purpose for this identifier, if known .",
"valueSet" : "http://hl7.org/fhir/ValueSet/identifier-use|4.0.0"
},
"mapping" : [
{
"identity" : "v2",
"map" : "N/A"
},
{
"identity" : "rim",
"map" : "Role.code or implied by context"
}
]
},
{
"id" : "Endpoint.identifier:smdtarget.type",
"path" : "Endpoint.identifier.type",
"short" : "Description of identifier",
"definition" : "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.",
"comment" : "This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.",
"requirements" : "Allows users to make use of identifiers when the identifier system is not known.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Identifier.type",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "CodeableConcept"
}
],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "IdentifierType"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}
],
"strength" : "extensible",
"description" : "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.",
"valueSet" : "http://hl7.org/fhir/ValueSet/identifier-type"
},
"mapping" : [
{
"identity" : "v2",
"map" : "CX.5"
},
{
"identity" : "rim",
"map" : "Role.code or implied by context"
}
]
},
{
"id" : "Endpoint.identifier:smdtarget.system",
"path" : "Endpoint.identifier.system",
"short" : "Secure Messaging Delivery Target Identifier",
"definition" : "Target identifier suitable for Secure Message Delivery interface metatadat content; also allows lookup for responses.",
"comment" : "Identifier.system is always case sensitive.",
"requirements" : "There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Identifier.system",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "uri"
}
],
"fixedUri" : "http://ns.electronichealth.net.au/smd/target",
"example" : [
{
"label" : "General",
"valueUri" : "http://www.acme.com/identifiers/patient"
}
],
"isModifier" : false,
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "CX.4 / EI-2-4"
},
{
"identity" : "rim",
"map" : "II.root or Role.id.root"
},
{
"identity" : "servd",
"map" : "./IdentifierType"
}
]
},
{
"id" : "Endpoint.identifier:smdtarget.value",
"path" : "Endpoint.identifier.value",
"short" : "Secure messaging target identifier value",
"definition" : "The portion of the identifier typically relevant to the user and which is unique within the context of the system.",
"comment" : "If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](http://hl7.org/fhir/R4/extension-rendered-value.html). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Identifier.value",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"example" : [
{
"label" : "General",
"valueString" : "123456"
}
],
"isModifier" : false,
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "CX.1 / EI.1"
},
{
"identity" : "rim",
"map" : "II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)"
},
{
"identity" : "servd",
"map" : "./Value"
}
]
},
{
"id" : "Endpoint.identifier:smdtarget.period",
"path" : "Endpoint.identifier.period",
"short" : "Time period when id is/was valid for use",
"definition" : "Time period during which identifier is/was valid for use.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Identifier.period",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Period"
}
],
"isModifier" : false,
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "CX.7 + CX.8"
},
{
"identity" : "rim",
"map" : "Role.effectiveTime or implied by context"
},
{
"identity" : "servd",
"map" : "./StartDate and ./EndDate"
}
]
},
{
"id" : "Endpoint.identifier:smdtarget.assigner",
"path" : "Endpoint.identifier.assigner",
"short" : "Organization that issued id (may be just text)",
"definition" : "Organization that issued/manages the identifier.",
"comment" : "The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Identifier.assigner",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Reference",
"targetProfile" : [
"http://hl7.org/fhir/StructureDefinition/Organization"
]
}
],
"isModifier" : false,
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "CX.4 / (CX.4,CX.9,CX.10)"
},
{
"identity" : "rim",
"map" : "II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper"
},
{
"identity" : "servd",
"map" : "./IdentifierIssuingAuthority"
}
]
},
{
"id" : "Endpoint.status",
"path" : "Endpoint.status",
"short" : "Required status",
"definition" : "Secure messaging endpoint activation status.",
"comment" : "This element is labeled as a modifier because the status contains codes that mark the endpoint as not currently valid.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Endpoint.status",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"mustSupport" : true,
"isModifier" : true,
"isModifierReason" : "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "EndpointStatus"
}
],
"strength" : "required",
"description" : "The status of the endpoint.",
"valueSet" : "http://hl7.org/fhir/ValueSet/endpoint-status|4.0.0"
},
"mapping" : [
{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Endpoint.connectionType",
"path" : "Endpoint.connectionType",
"short" : "Service interface type",
"definition" : "Protocol/Profile/Standard the endpoint supports.",
"comment" : "For additional connectivity details for the protocol, extensions will be used at this point, as in the XDS example.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Endpoint.connectionType",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "Coding"
}
],
"mustSupport" : true,
"isModifier" : false,
"isSummary" : true,
"binding" : {
"strength" : "extensible",
"valueSet" : "http://hl7.org.au/fhir/pd/ValueSet/service-interfaces"
},
"mapping" : [
{
"identity" : "w5",
"map" : "FiveWs.class"
},
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Endpoint.name",
"path" : "Endpoint.name",
"short" : "Friendly name for the endpoint",
"definition" : "A friendly name that this endpoint can be referred to with.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Endpoint.name",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"mustSupport" : true,
"isModifier" : false,
"isSummary" : true,
"mapping" : [
{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Endpoint.managingOrganization",
"path" : "Endpoint.managingOrganization",
"short" : "Directory entry managing organisation",
"definition" : "Details of the organisation that is managing the supply of this directory entry.",
"comment" : "This property is not typically used when searching for Endpoint resources for usage. The typical usage is via the reference from an applicable Organization/Location/Practitioner resource, which is where the context is provided. Multiple Locations may reference a single endpoint, and don't have to be within the same organization resource, but most likely within the same organizational hierarchy.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Endpoint.managingOrganization",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Reference",
"targetProfile" : [
"http://hl7.org/fhir/StructureDefinition/Organization"
]
}
],
"mustSupport" : true,
"isModifier" : false,
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Endpoint.managingOrganization.id",
"path" : "Endpoint.managingOrganization.id",
"representation" : [
"xmlAttr"
],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Endpoint.managingOrganization.extension",
"path" : "Endpoint.managingOrganization.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Endpoint.managingOrganization.reference",
"path" : "Endpoint.managingOrganization.reference",
"short" : "Literal reference, Relative, internal or absolute URL",
"definition" : "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.",
"comment" : "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure \"/[type]/[id]\" then it should be assumed that the reference is to a FHIR RESTful server.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Reference.reference",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ref-1"
],
"isModifier" : false,
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Endpoint.managingOrganization.type",
"path" : "Endpoint.managingOrganization.type",
"short" : "Type the reference refers to (e.g. \"Patient\")",
"definition" : "The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.\n\nThe type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. \"Patient\" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).",
"comment" : "This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Reference.type",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "uri"
}
],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "FHIRResourceTypeExt"
}
],
"strength" : "extensible",
"description" : "Aa resource (or, for logical models, the URI of the logical model).",
"valueSet" : "http://hl7.org/fhir/ValueSet/resource-types"
},
"mapping" : [
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Endpoint.managingOrganization.identifier",
"path" : "Endpoint.managingOrganization.identifier",
"short" : "Logical reference, when literal reference is not known",
"definition" : "An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.",
"comment" : "When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.\n\nReference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Reference.identifier",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Identifier"
}
],
"isModifier" : false,
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : ".identifier"
}
]
},
{
"id" : "Endpoint.managingOrganization.display",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean" : true
}
],
"path" : "Endpoint.managingOrganization.display",
"short" : "Directroy entry managing organisation display details",
"definition" : "Details to display for the directory entry managing organisation, typically the name.",
"comment" : "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Reference.display",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"isModifier" : false,
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Endpoint.contact",
"path" : "Endpoint.contact",
"short" : "Endpoint operator contact",
"definition" : "Details to contact operator of the endpoint responsible for it's support and maintenance.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Endpoint.contact",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "ContactPoint"
}
],
"mustSupport" : true,
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Endpoint.period",
"path" : "Endpoint.period",
"short" : "Interval the endpoint is expected to be operational",
"definition" : "The interval during which the endpoint is expected to be operational.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Endpoint.period",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Period"
}
],
"isModifier" : false,
"isSummary" : true,
"mapping" : [
{
"identity" : "w5",
"map" : "FiveWs.done[x]"
},
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Endpoint.payloadType",
"path" : "Endpoint.payloadType",
"short" : "Payload type",
"definition" : "Reference to identify the type of payload content (service category).",
"comment" : "The payloadFormat describes the serialization format of the data, where the payloadType indicates the specific document/schema that is being transferred; e.g. DischargeSummary or CarePlan.",
"min" : 1,
"max" : "*",
"base" : {
"path" : "Endpoint.payloadType",
"min" : 1,
"max" : "*"
},
"type" : [
{
"code" : "CodeableConcept"
}
],
"mustSupport" : true,
"isModifier" : false,
"isSummary" : true,
"binding" : {
"strength" : "extensible",
"valueSet" : "http://hl7.org.au/fhir/pd/ValueSet/endpoint-payload-type"
},
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Endpoint.payloadMimeType",
"path" : "Endpoint.payloadMimeType",
"short" : "Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)",
"definition" : "The mime type to send the payload in - e.g. application/fhir+xml, application/fhir+json. If the mime type is not specified, then the sender could send any content (including no content depending on the connectionType).",
"comment" : "Sending the payload has obvious security consequences. The server is responsible for ensuring that the content is appropriately secured.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Endpoint.payloadMimeType",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "code"
}
],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MimeType"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}
],
"strength" : "required",
"description" : "The mime type of an attachment. Any valid mime type is allowed.",
"valueSet" : "http://hl7.org/fhir/ValueSet/mimetypes|4.0.0"
},
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Endpoint.address",
"path" : "Endpoint.address",
"short" : "URL address of the endpoint",
"definition" : "Actual endpoint URL for communications",
"comment" : "For rest-hook, and websocket, the end-point must be an http: or https: URL; for email, a mailto: url, for sms, a tel: url, and for message the endpoint can be in any form of url the server understands (usually, http: or mllp:). The URI is allowed to be relative; in which case, it is relative to the server end-point (since there may be more than one, clients should avoid using relative URIs)\n\nThis address will be to the service base, without any parameters, or sub-services or resources tacked on.\n\nE.g. for a WADO-RS endpoint, the url should be \"https://pacs.hospital.org/wado-rs\"\n\nand not \"https://pacs.hospital.org/wado-rs/studies/1.2.250.1.59.40211.12345678.678910/series/1.2.250.1.59.40211.789001276.14556172.67789/instances/...\".",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Endpoint.address",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "url"
}
],
"mustSupport" : true,
"isModifier" : false,
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Endpoint.header",
"path" : "Endpoint.header",
"short" : "Usage depends on the channel type",
"definition" : "Additional headers / information to send as part of the notification.",
"comment" : "Exactly what these mean depends on the channel type. The can convey additional information to the recipient and/or meet security requirements.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Endpoint.header",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "string"
}
],
"isModifier" : false,
"isSummary" : false
}
]
},
"differential" : {
"element" : [
{
"id" : "Endpoint",
"path" : "Endpoint",
"short" : "Australian Secure Message Directory Endpoint Record",
"definition" : "Enpoint defined for use in secure message addressing."
},
{
"id" : "Endpoint.meta",
"path" : "Endpoint.meta",
"short" : "Metadata on Endpoint"
},
{
"id" : "Endpoint.meta.source",
"path" : "Endpoint.meta.source",
"mustSupport" : true
},
{
"id" : "Endpoint.extension",
"path" : "Endpoint.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"rules" : "open"
}
},
{
"id" : "Endpoint.extension:receivingFacility",
"path" : "Endpoint.extension",
"sliceName" : "receivingFacility",
"max" : "1",
"type" : [
{
"code" : "Extension",
"profile" : [
"http://hl7.org.au/fhir/StructureDefinition/au-receivingfacility"
]
}
]
},
{
"id" : "Endpoint.extension:receivingApplication",
"path" : "Endpoint.extension",
"sliceName" : "receivingApplication",
"max" : "1",
"type" : [
{
"code" : "Extension",
"profile" : [
"http://hl7.org.au/fhir/StructureDefinition/au-receivingapplication"
]
}
]
},
{
"id" : "Endpoint.extension:dataEnciphermentCertificate",
"path" : "Endpoint.extension",
"sliceName" : "dataEnciphermentCertificate",
"type" : [
{
"code" : "Extension",
"profile" : [
"http://hl7.org.au/fhir/StructureDefinition/encryption-certificate-pem-x509"
]
}
]
},
{
"id" : "Endpoint.identifier",
"path" : "Endpoint.identifier",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "system"
}
],
"rules" : "open"
}
},
{
"id" : "Endpoint.identifier:smdtarget",
"path" : "Endpoint.identifier",
"sliceName" : "smdtarget",
"short" : "Secure Messaging Target Identifier",
"definition" : "Secure messaging interface target identity included in addressing metadata. Thiis is the complete URL identifier that can be directly used in secure messaging. This identifier should be matched when selecting the encrypting certificate data used for payload encryption also referenced from this endpoint.",
"mustSupport" : true
},
{
"id" : "Endpoint.identifier:smdtarget.system",
"path" : "Endpoint.identifier.system",
"short" : "Secure Messaging Delivery Target Identifier",
"definition" : "Target identifier suitable for Secure Message Delivery interface metatadat content; also allows lookup for responses.",
"min" : 1,
"fixedUri" : "http://ns.electronichealth.net.au/smd/target"
},
{
"id" : "Endpoint.identifier:smdtarget.value",
"path" : "Endpoint.identifier.value",
"short" : "Secure messaging target identifier value",
"min" : 1
},
{
"id" : "Endpoint.status",
"path" : "Endpoint.status",
"short" : "Required status",
"definition" : "Secure messaging endpoint activation status.",
"mustSupport" : true
},
{
"id" : "Endpoint.connectionType",
"path" : "Endpoint.connectionType",
"short" : "Service interface type",
"definition" : "Protocol/Profile/Standard the endpoint supports.",
"mustSupport" : true,
"binding" : {
"strength" : "extensible",
"valueSet" : "http://hl7.org.au/fhir/pd/ValueSet/service-interfaces"
}
},
{
"id" : "Endpoint.name",
"path" : "Endpoint.name",
"short" : "Friendly name for the endpoint",
"mustSupport" : true
},
{
"id" : "Endpoint.managingOrganization",
"path" : "Endpoint.managingOrganization",
"short" : "Directory entry managing organisation",
"definition" : "Details of the organisation that is managing the supply of this directory entry.",
"min" : 1,
"mustSupport" : true
},
{
"id" : "Endpoint.managingOrganization.display",
"path" : "Endpoint.managingOrganization.display",
"short" : "Directroy entry managing organisation display details",
"definition" : "Details to display for the directory entry managing organisation, typically the name.",
"min" : 1
},
{
"id" : "Endpoint.contact",
"path" : "Endpoint.contact",
"short" : "Endpoint operator contact",
"definition" : "Details to contact operator of the endpoint responsible for it's support and maintenance.",
"mustSupport" : true
},
{
"id" : "Endpoint.payloadType",
"path" : "Endpoint.payloadType",
"short" : "Payload type",
"definition" : "Reference to identify the type of payload content (service category).",
"mustSupport" : true,
"binding" : {
"strength" : "extensible",
"valueSet" : "http://hl7.org.au/fhir/pd/ValueSet/endpoint-payload-type"
}
},
{
"id" : "Endpoint.address",
"path" : "Endpoint.address",
"short" : "URL address of the endpoint",
"definition" : "Actual endpoint URL for communications",
"mustSupport" : true
}
]
}
}
XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.